home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_perl.idb / usr / freeware / catman / p_man / cat3 / Pod::Html.Z / Pod::Html
Encoding:
Text File  |  1998-10-28  |  4.6 KB  |  265 lines
  1.  
  2.  
  3.  
  4.      PPPPoooodddd::::::::HHHHttttmmmmllll((((3333))))     4444////AAAAuuuugggg////99998888 ((((ppppeeeerrrrllll 5555....000000005555,,,, ppppaaaattttcccchhhh 00002222))))      PPPPoooodddd::::::::HHHHttttmmmmllll((((3333))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       Pod::Html - module to    convert    pod files to HTML
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           use Pod::Html;
  13.           pod2html([options]);
  14.  
  15.  
  16.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  17.       Converts files from pod format (see the _p_e_r_l_p_o_d manpage) to
  18.       HTML format.    It can automatically generate indexes and
  19.       cross-references, and    it keeps a cache of things it knows
  20.       how to cross-reference.
  21.  
  22.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  23.       Pod::Html takes the following    arguments:
  24.  
  25.       help
  26.  
  27.           --help
  28.  
  29.           Displays the usage message.
  30.  
  31.       htmlroot
  32.  
  33.           --htmlroot=name
  34.  
  35.           Sets the base URL    for the    HTML files.  When cross-
  36.           references are made, the HTML root is prepended to the
  37.           URL.
  38.  
  39.       infile
  40.  
  41.           --infile=name
  42.  
  43.           Specify the pod file to convert.    Input is taken from
  44.           STDIN if no infile is specified.
  45.  
  46.       outfile
  47.  
  48.           --outfile=name
  49.  
  50.           Specify the HTML file to create.    Output goes to STDOUT
  51.           if no outfile is specified.
  52.  
  53.       podroot
  54.  
  55.           --podroot=name
  56.  
  57.           Specify the base directory for finding library pods.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                        (printed 10/23/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      PPPPoooodddd::::::::HHHHttttmmmmllll((((3333))))     4444////AAAAuuuugggg////99998888 ((((ppppeeeerrrrllll 5555....000000005555,,,, ppppaaaattttcccchhhh 00002222))))      PPPPoooodddd::::::::HHHHttttmmmmllll((((3333))))
  71.  
  72.  
  73.  
  74.       podpath
  75.  
  76.           --podpath=name:...:name
  77.  
  78.           Specify which subdirectories of the podroot contain pod
  79.           files whose HTML converted forms can be linked-to    in
  80.           cross-references.
  81.  
  82.       libpods
  83.  
  84.           --libpods=name:...:name
  85.  
  86.           List of page names (eg, "perlfunc") which    contain
  87.           linkable =items.
  88.  
  89.       netscape
  90.  
  91.           --netscape
  92.  
  93.           Use Netscape HTML    directives when    applicable.
  94.  
  95.       nonetscape
  96.  
  97.           --nonetscape
  98.  
  99.           Do not use Netscape HTML directives (default).
  100.  
  101.       index
  102.  
  103.           --index
  104.  
  105.           Generate an index    at the top of the HTML file (default
  106.           behaviour).
  107.  
  108.       noindex
  109.  
  110.           --noindex
  111.  
  112.           Do not generate an index at the top of the HTML file.
  113.  
  114.       recurse
  115.  
  116.           --recurse
  117.  
  118.           Recurse into subdirectories specified in podpath
  119.           (default behaviour).
  120.  
  121.       norecurse
  122.  
  123.           --norecurse
  124.  
  125.           Do not recurse into subdirectories specified in podpath.
  126.  
  127.  
  128.  
  129.      Page 2                        (printed 10/23/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      PPPPoooodddd::::::::HHHHttttmmmmllll((((3333))))     4444////AAAAuuuugggg////99998888 ((((ppppeeeerrrrllll 5555....000000005555,,,, ppppaaaattttcccchhhh 00002222))))      PPPPoooodddd::::::::HHHHttttmmmmllll((((3333))))
  137.  
  138.  
  139.  
  140.       title
  141.  
  142.           --title=title
  143.  
  144.           Specify the title    of the resulting HTML file.
  145.  
  146.       verbose
  147.  
  148.           --verbose
  149.  
  150.           Display progress messages.
  151.  
  152.      EEEEXXXXAAAAMMMMPPPPLLLLEEEE
  153.           pod2html("pod2html",
  154.                "--podpath=lib:ext:pod:vms",
  155.                "--podroot=/usr/src/perl",
  156.                "--htmlroot=/perl/nmanual",
  157.                "--libpods=perlfunc:perlguts:perlvar:perlrun:perlop",
  158.                "--recurse",
  159.                "--infile=foo.pod",
  160.                "--outfile=/perl/nmanual/foo.html");
  161.  
  162.  
  163.      AAAAUUUUTTTTHHHHOOOORRRR
  164.       Tom Christiansen, <tchrist@perl.com>.
  165.  
  166.      BBBBUUUUGGGGSSSS
  167.       Has trouble with  etc    in = commands.
  168.  
  169.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  170.       the _p_e_r_l_p_o_d manpage
  171.  
  172.      CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT
  173.       This program is distributed under the    Artistic License.
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                        (printed 10/23/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      PPPPoooodddd::::::::HHHHttttmmmmllll((((3333))))     4444////AAAAuuuugggg////99998888 ((((ppppeeeerrrrllll 5555....000000005555,,,, ppppaaaattttcccchhhh 00002222))))      PPPPoooodddd::::::::HHHHttttmmmmllll((((3333))))
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.      Page 4                        (printed 10/23/98)
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.